Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closes #2487 general issue move deprecated arguments and functions to next phase or remove #2500

Conversation

StefanThoma
Copy link
Collaborator

@StefanThoma StefanThoma commented Aug 27, 2024

Thank you for your Pull Request! We have developed this task checklist from the Development Process Guide to help with the final steps of the process. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the admiral codebase remains robust and consistent.

Please check off each taskbox as an acknowledgment that you completed the task or check off that it is not relevant to your Pull Request. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the main branch until you have checked off each task.

  • Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
  • Code is formatted according to the tidyverse style guide. Run styler::style_file() to style R and Rmd files
  • Updated relevant unit tests or have written new unit tests, which should consider realistic data scenarios and edge cases, e.g. empty datasets, errors, boundary cases etc. - See Unit Test Guide
  • If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance?
  • Review the Cheat Sheet. Make any required updates to it by editing the file inst/cheatsheet/admiral_cheatsheet.pptx and re-upload a PDF and a PNG version of it to the same folder. (The PNG version can be created by taking a screenshot of the PDF version.)
  • Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family.
  • Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
  • Address any updates needed for vignettes and/or templates
  • Update NEWS.md under the header # admiral (development version) if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers). A Developer Notes section is available in NEWS.md for tracking developer-facing issues.
  • Build admiral site pkgdown::build_site() and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.
  • Address or fix all lintr warnings and errors - lintr::lint_package()
  • Run R CMD check locally and address all errors and warnings - devtools::check()
  • Link the issue in the Development Section on the right hand side.
  • Address all merge conflicts and resolve appropriately
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

@StefanThoma StefanThoma linked an issue Aug 27, 2024 that may be closed by this pull request
6 tasks
@StefanThoma StefanThoma self-assigned this Aug 27, 2024
Copy link

github-actions bot commented Aug 27, 2024

Code Coverage

Package Line Rate Health
admiral 97%
Summary 97% (4881 / 5043)

@StefanThoma StefanThoma changed the title 2487 general issue move deprecated arguments and functions to next phase or remove Closes #2487 general issue move deprecated arguments and functions to next phase or remove Aug 28, 2024
@StefanThoma StefanThoma requested a review from bundfussr August 28, 2024 06:45
@StefanThoma
Copy link
Collaborator Author

It complains about the link:
https://www.fda.gov/media/116737/download
But for me it works...

@StefanThoma
Copy link
Collaborator Author

I see, thi

It complains about the link: https://www.fda.gov/media/116737/download But for me it works...

Ah this has been discussed here: #2494 (comment)

@StefanThoma
Copy link
Collaborator Author

@bundfussr all deprecations went from error to removal.
There were no deprecations in stage 1.


### Phase 3 (removed)
- `consolidate_metadata(check_keys)`
- Removed at v1.1.1 `compute_egfr(wt)`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did this one get updated?? I don't see it changed in the list of files. compute_kidney.R

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or did we miss it in the last release?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the repo: https://github.com/pharmaverse/admiral/blob/2487-general-issue-move-deprecated-arguments-and-functions-to-next-phase-or-remove/R/compute_kidney.R
There is no wt argument anymore.
This is the case for a few other arguments down the line of the list in news.md (indicated by me with: Removed at v1.1.1)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah so we missed these! Thanks for clarifying and be specific in the news section.

Copy link
Collaborator

@bms63 bms63 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoa - feels like end of era where we are not constantly deprecating stuff! @rossfarrugia no phase 1 or phase 2 happening...we at least not yet but it will be minimal.

@bms63
Copy link
Collaborator

bms63 commented Aug 29, 2024

@StefanThoma do you have time to check on admiraldev or ask @sadchla-codes where she is at on finishing. I think the updates were pretty minimal.

@bms63
Copy link
Collaborator

bms63 commented Aug 30, 2024

Many thanks @StefanThoma for getting this completed!

@bms63 bms63 merged commit 09f48ec into main Aug 30, 2024
16 checks passed
@bms63 bms63 deleted the 2487-general-issue-move-deprecated-arguments-and-functions-to-next-phase-or-remove branch August 30, 2024 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

General Issue: Move deprecated arguments and functions to next phase or remove
2 participants